home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_1 / cpdist / cpdist.doc < prev    next >
Text File  |  1994-01-12  |  4KB  |  82 lines
  1.  
  2.      CPDIST(1)                                                   CPDIST(1)
  3.  
  4.      NAME
  5.           cpdist - distribution copy command
  6.  
  7.      SYNOPSIS
  8.           cpdist [options] destination
  9.  
  10.      DESCRIPTION
  11.           cpdist is a copy command which takes the source filenames
  12.           out of a seperate file called 'distfile' in this doc.
  13.  
  14.           Most people already use sth. like a distfile to inform others
  15.           about the use or type of files in a distribution.
  16.           The main idea behind cpdist was to combine the informative use
  17.           of these index files with the ability of copying the files listed
  18.           there.
  19.  
  20.           Rich documentation is very essencial and so the author decided
  21.           to implement the support of C and C++ like comments in a distfile.
  22.           A C comment is imbeded into a '/*' prefix and the matching '*/'
  23.           The C++ comments (also called remarks here) begin with a '//' and
  24.           end with the end of the line they appear in.  Have a closer look
  25.           on the supplied distfile.
  26.  
  27.           The files listed in a distfile must be seperated by white space,
  28.           i.e. a space or tab character or the end of a line.  Filenames
  29.           containing white spaces have to be quoted with double quotes '"'.
  30.  
  31.           It is also possible to place so called distribution 'keys' in a
  32.           distfile.  A key is a character string followed by a colon ´:'
  33.           and a white space, i.e. a space, tab or newline chatracter.
  34.           It introduces a list of filenames which will only be copied if
  35.           the leading key is valid.  In other words, every filename between
  36.           two distribution keys or a leading key and the end of file is
  37.           ignored if the leading key is not valid.  By default all keys are
  38.           invalid, i.e. only files without a leading distribution key will
  39.           be copied.  You can make a key valid using the -D key option.
  40.  
  41.           It has never been easier for the author to prepare a distribution
  42.           as in was in case of cpdist!
  43.  
  44.      OPTIONS
  45.           -a       Replace files in the destination path without asking.
  46.           -b n     Sets the copy buffer to <n> bytes.  (limited to 64K
  47.                    on some machines)
  48.           -c       Checks the existence of all source files before copying
  49.                    anything.
  50.           -D key   make a distribution 'key' valid (see above).
  51.           -E file  Redirects errors to <file>.
  52.           -f file  Sets the name of the distfile to <file>.  The default
  53.                    name is 'distfile'.
  54.           -h       Displays short help information and exits.
  55.           -i       Ignores (syntactic) errors in the distfile
  56.           -k       Keeps on going in case of I/O errors
  57.           -n       Don't copy anything -- just print.
  58.                    This option allows backticked usage of cpdist:
  59.  
  60.                    1> tar cf x.tar `cpdist -n`
  61.  
  62.                    ... achrives all files listed in the Distfile.
  63.  
  64.           -q or    Silent (quiet) cpdist won't print each filename when
  65.           -s       copying.
  66.           -v       Displays a short version information.
  67.  
  68.      NOTE
  69.           (1) cpdist will _not_ create any sub-directories in your
  70.               destination path.  You should avoid the use of pathnames
  71.               in your distfile if you don't know exactly what will happen.
  72.  
  73.           (2) cpdist _must_ be run exactly from the folder (directory) which
  74.               contains the files listed in the distfile.
  75.  
  76.  
  77.      AUTHOR
  78.           Tobias Ferber, Goethestraße 32, 76135 Karlsruhe, Germany
  79.  
  80.           Earn:      ukjg@dkauni2.bitnet
  81.           InterNet:  ukjg@ibm3090.rz.uni-karlsruhe.de
  82.